Resource URL: /platform/<<version=3>>/local/cluster/nodes/<LNN>/state/readonly

    Overview: This resource applies the standard collection pattern to
              individual nodes.  LNN in the resource path is the node lnn ID.

     Methods: GET, PUT

********************************************************************************

Method GET: Retrieve node readonly state information.

       URL: GET /platform/<<version=3>>/local/cluster/nodes/<LNN>/state/readonly

There are no query arguments for this method.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "nodes": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "description": "Node readonly state.", 
            "properties": {
              "status": {
                "type": [
                  "string", 
                  "integer"
                ], 
                "description": "The current read-only mode status description for the node."
              }, 
              "valid": {
                "type": "boolean", 
                "description": "The read-only state values are valid (False = Error)."
              }, 
              "enabled": {
                "type": "boolean", 
                "description": "The current read-only user mode status for the node. NOTE: If read-only mode is currently disallowed for this node, it will remain read/write until read-only mode is allowed again. This value only sets or clears any user-specified requests for read-only mode. If the node has been placed into read-only mode by the system, it will remain in read-only mode until the system conditions which triggered read-only mode have cleared."
              }, 
              "value": {
                "type": "integer", 
                "description": "The current read-only value (enumerated bitfield) for the node."
              }, 
              "lnn": {
                "type": "integer", 
                "description": "Logical Node Number (LNN) of this node."
              }, 
              "mode": {
                "type": "boolean", 
                "description": "The current read-only mode status for the node."
              }, 
              "allowed": {
                "type": "boolean", 
                "description": "The current read-only mode allowed status for the node."
              }, 
              "id": {
                "type": "integer", 
                "description": "Node ID (Device Number) of this node."
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }, 
        "total": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Total number of items available.", 
          "maximum": 4294967295
        }
      }
    }
  ]
}

********************************************************************************

Method PUT: Modify one or more node readonly state settings.

       URL: PUT /platform/<<version=3>>/local/cluster/nodes/<LNN>/state/readonly

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "description": "Node readonly state.", 
  "properties": {
    "status": {
      "type": [
        "string", 
        "integer"
      ], 
      "description": "The current read-only mode status description for the node."
    }, 
    "enabled": {
      "type": "boolean", 
      "description": "The current read-only user mode status for the node. NOTE: If read-only mode is currently disallowed for this node, it will remain read/write until read-only mode is allowed again. This value only sets or clears any user-specified requests for read-only mode. If the node has been placed into read-only mode by the system, it will remain in read-only mode until the system conditions which triggered read-only mode have cleared."
    }, 
    "value": {
      "type": "integer", 
      "description": "The current read-only value (enumerated bitfield) for the node."
    }, 
    "valid": {
      "type": "boolean", 
      "description": "The read-only state values are valid (False = Error)."
    }, 
    "mode": {
      "type": "boolean", 
      "description": "The current read-only mode status for the node."
    }, 
    "allowed": {
      "type": "boolean", 
      "description": "The current read-only mode allowed status for the node."
    }
  }
}

There is no JSON response body for this method.
